<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PDNSim: IRSolver Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">PDNSim
   </div>
   <div id="projectbrief">Power grid analysis</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">IRSolver Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Class for IR solver.  
 <a href="classIRSolver.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="ir__solver_8h_source.html">ir_solver.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ade5e2e1c97895d8e9c37141f62eccbd9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIRSolver.html#ade5e2e1c97895d8e9c37141f62eccbd9">IRSolver</a> (odb::dbDatabase *t_db, std::string verilog_stor, std::string top_module, std::string sdc_file, std::vector&lt; std::string &gt; lib_stor, std::string vsrc_loc)</td></tr>
<tr class="memdesc:ade5e2e1c97895d8e9c37141f62eccbd9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor for <a class="el" href="classIRSolver.html" title="Class for IR solver. ">IRSolver</a> class.  <a href="#ade5e2e1c97895d8e9c37141f62eccbd9">More...</a><br /></td></tr>
<tr class="separator:ade5e2e1c97895d8e9c37141f62eccbd9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f8f596fc1314294c91650c9aea1b276"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIRSolver.html#a3f8f596fc1314294c91650c9aea1b276">~IRSolver</a> ()</td></tr>
<tr class="memdesc:a3f8f596fc1314294c91650c9aea1b276"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classIRSolver.html" title="Class for IR solver. ">IRSolver</a> destructor.  <a href="#a3f8f596fc1314294c91650c9aea1b276">More...</a><br /></td></tr>
<tr class="separator:a3f8f596fc1314294c91650c9aea1b276"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a72b07b8b929136c0cac95077dce87990"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGMat.html">GMat</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIRSolver.html#a72b07b8b929136c0cac95077dce87990">GetGMat</a> ()</td></tr>
<tr class="memdesc:a72b07b8b929136c0cac95077dce87990"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the created G matrix for the design.  <a href="#a72b07b8b929136c0cac95077dce87990">More...</a><br /></td></tr>
<tr class="separator:a72b07b8b929136c0cac95077dce87990"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a15a1b2f7bbbd71cd568e532bf03ce1b0"><td class="memItemLeft" align="right" valign="top">std::vector&lt; double &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIRSolver.html#a15a1b2f7bbbd71cd568e532bf03ce1b0">GetJ</a> ()</td></tr>
<tr class="memdesc:a15a1b2f7bbbd71cd568e532bf03ce1b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns current map represented as a 1D vector.  <a href="#a15a1b2f7bbbd71cd568e532bf03ce1b0">More...</a><br /></td></tr>
<tr class="separator:a15a1b2f7bbbd71cd568e532bf03ce1b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad0c6ef5800e5892f441e11b57d19dcaf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIRSolver.html#ad0c6ef5800e5892f441e11b57d19dcaf">SolveIR</a> ()</td></tr>
<tr class="memdesc:ad0c6ef5800e5892f441e11b57d19dcaf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function to solve for IR drop.  <a href="#ad0c6ef5800e5892f441e11b57d19dcaf">More...</a><br /></td></tr>
<tr class="separator:ad0c6ef5800e5892f441e11b57d19dcaf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:addd237968206ba6e1c875180eddd562f"><td class="memItemLeft" align="right" valign="top">std::vector&lt; std::pair&lt; std::string, double &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIRSolver.html#addd237968206ba6e1c875180eddd562f">GetPower</a> ()</td></tr>
<tr class="memdesc:addd237968206ba6e1c875180eddd562f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function to get the power value from OpenSTA.  <a href="#addd237968206ba6e1c875180eddd562f">More...</a><br /></td></tr>
<tr class="separator:addd237968206ba6e1c875180eddd562f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:aa994255bf8405bc13d0a887797b8bc42"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIRSolver.html#aa994255bf8405bc13d0a887797b8bc42">wc_voltage</a></td></tr>
<tr class="memdesc:aa994255bf8405bc13d0a887797b8bc42"><td class="mdescLeft">&#160;</td><td class="mdescRight">Worst case voltage at the lowest layer nodes.  <a href="#aa994255bf8405bc13d0a887797b8bc42">More...</a><br /></td></tr>
<tr class="separator:aa994255bf8405bc13d0a887797b8bc42"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc781b74c7a8a7af351f55d06d00a922"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIRSolver.html#acc781b74c7a8a7af351f55d06d00a922">vdd</a></td></tr>
<tr class="memdesc:acc781b74c7a8a7af351f55d06d00a922"><td class="mdescLeft">&#160;</td><td class="mdescRight">Voltage supply.  <a href="#acc781b74c7a8a7af351f55d06d00a922">More...</a><br /></td></tr>
<tr class="separator:acc781b74c7a8a7af351f55d06d00a922"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa0336f80d573aecc0e6269d7f91441cc"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIRSolver.html#aa0336f80d573aecc0e6269d7f91441cc">avg_voltage</a></td></tr>
<tr class="memdesc:aa0336f80d573aecc0e6269d7f91441cc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Average voltage at lowest layer nodes.  <a href="#aa0336f80d573aecc0e6269d7f91441cc">More...</a><br /></td></tr>
<tr class="separator:aa0336f80d573aecc0e6269d7f91441cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a06dc6ff621f8d90cea84fe74e1d9ffda"><td class="memItemLeft" align="right" valign="top">std::vector&lt; double &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIRSolver.html#a06dc6ff621f8d90cea84fe74e1d9ffda">wc_volt_layer</a></td></tr>
<tr class="memdesc:a06dc6ff621f8d90cea84fe74e1d9ffda"><td class="mdescLeft">&#160;</td><td class="mdescRight">Vector of worstcase voltages in the lowest layers.  <a href="#a06dc6ff621f8d90cea84fe74e1d9ffda">More...</a><br /></td></tr>
<tr class="separator:a06dc6ff621f8d90cea84fe74e1d9ffda"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Class for IR solver. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ade5e2e1c97895d8e9c37141f62eccbd9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ade5e2e1c97895d8e9c37141f62eccbd9">&#9670;&nbsp;</a></span>IRSolver()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">IRSolver::IRSolver </td>
          <td>(</td>
          <td class="paramtype">odb::dbDatabase *&#160;</td>
          <td class="paramname"><em>t_db</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::string&#160;</td>
          <td class="paramname"><em>verilog_stor</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::string&#160;</td>
          <td class="paramname"><em>top_module</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::string&#160;</td>
          <td class="paramname"><em>sdc_file</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::vector&lt; std::string &gt;&#160;</td>
          <td class="paramname"><em>lib_stor</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::string&#160;</td>
          <td class="paramname"><em>vsrc_loc</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Constructor for <a class="el" href="classIRSolver.html" title="Class for IR solver. ">IRSolver</a> class. </p>

</div>
</div>
<a id="a3f8f596fc1314294c91650c9aea1b276"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3f8f596fc1314294c91650c9aea1b276">&#9670;&nbsp;</a></span>~IRSolver()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">IRSolver::~IRSolver </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p><a class="el" href="classIRSolver.html" title="Class for IR solver. ">IRSolver</a> destructor. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a72b07b8b929136c0cac95077dce87990"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a72b07b8b929136c0cac95077dce87990">&#9670;&nbsp;</a></span>GetGMat()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classGMat.html">GMat</a> * IRSolver::GetGMat </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the created G matrix for the design. </p>

</div>
</div>
<a id="a15a1b2f7bbbd71cd568e532bf03ce1b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a15a1b2f7bbbd71cd568e532bf03ce1b0">&#9670;&nbsp;</a></span>GetJ()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">vector&lt; double &gt; IRSolver::GetJ </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns current map represented as a 1D vector. </p>

</div>
</div>
<a id="addd237968206ba6e1c875180eddd562f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#addd237968206ba6e1c875180eddd562f">&#9670;&nbsp;</a></span>GetPower()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">vector&lt; pair&lt; string, double &gt; &gt; IRSolver::GetPower </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Function to get the power value from OpenSTA. </p>

</div>
</div>
<a id="ad0c6ef5800e5892f441e11b57d19dcaf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad0c6ef5800e5892f441e11b57d19dcaf">&#9670;&nbsp;</a></span>SolveIR()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void IRSolver::SolveIR </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Function to solve for IR drop. </p>
<p>Function to solve for voltage using SuperLU. </p>

</div>
</div>
<h2 class="groupheader">Field Documentation</h2>
<a id="aa0336f80d573aecc0e6269d7f91441cc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa0336f80d573aecc0e6269d7f91441cc">&#9670;&nbsp;</a></span>avg_voltage</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double IRSolver::avg_voltage</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Average voltage at lowest layer nodes. </p>

</div>
</div>
<a id="acc781b74c7a8a7af351f55d06d00a922"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acc781b74c7a8a7af351f55d06d00a922">&#9670;&nbsp;</a></span>vdd</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double IRSolver::vdd</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Voltage supply. </p>

</div>
</div>
<a id="a06dc6ff621f8d90cea84fe74e1d9ffda"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a06dc6ff621f8d90cea84fe74e1d9ffda">&#9670;&nbsp;</a></span>wc_volt_layer</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::vector&lt;double&gt; IRSolver::wc_volt_layer</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Vector of worstcase voltages in the lowest layers. </p>

</div>
</div>
<a id="aa994255bf8405bc13d0a887797b8bc42"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa994255bf8405bc13d0a887797b8bc42">&#9670;&nbsp;</a></span>wc_voltage</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double IRSolver::wc_voltage</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Worst case voltage at the lowest layer nodes. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/<a class="el" href="ir__solver_8h_source.html">ir_solver.h</a></li>
<li>src/<a class="el" href="ir__solver_8cpp.html">ir_solver.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
